Patch
|
|||||
|
|
||||
Updates an existing targeting template. This method supports patch semantics
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 108 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
id Required |
INTEGER |
Targeting template ID |
accountId |
INTEGER |
Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
advertiserId |
INTEGER |
Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
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 |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
dayPartTargeting |
OBJECT |
Day Part Targeting |
dayPartTargeting.daysOfWeek[] |
ENUMERATION |
|
dayPartTargeting.hoursOfDay[] |
INTEGER |
|
dayPartTargeting.userLocalTime |
BOOLEAN |
Whether or not to use the user's local time. If false, the America/New York time zone applies |
geoTargeting |
OBJECT |
Geographical Targeting |
geoTargeting.cities[] |
OBJECT |
Contains information about a city that can be targeted by ads |
geoTargeting.cities[].countryCode |
STRING |
Country code of the country to which this city belongs |
geoTargeting.cities[].countryDartId |
INTEGER |
DART ID of the country to which this city belongs |
geoTargeting.cities[].dartId |
INTEGER |
DART ID of this city. This is the ID used for targeting and generating reports |
geoTargeting.cities[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#city" |
geoTargeting.cities[].metroCode |
STRING |
Metro region code of the metro region (DMA) to which this city belongs |
geoTargeting.cities[].metroDmaId |
INTEGER |
ID of the metro region (DMA) to which this city belongs |
geoTargeting.cities[].name |
STRING |
Name of this city |
geoTargeting.cities[].regionCode |
STRING |
Region code of the region to which this city belongs |
geoTargeting.cities[].regionDartId |
INTEGER |
DART ID of the region to which this city belongs |
geoTargeting.countries[] |
OBJECT |
Contains information about a country that can be targeted by ads |
geoTargeting.countries[].countryCode |
STRING |
Country code |
geoTargeting.countries[].dartId |
INTEGER |
DART ID of this country. This is the ID used for targeting and generating reports |
geoTargeting.countries[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#country" |
geoTargeting.countries[].name |
STRING |
Name of this country |
geoTargeting.countries[].sslEnabled |
BOOLEAN |
Whether ad serving supports secure servers in this country |
geoTargeting.excludeCountries |
BOOLEAN |
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 |
geoTargeting.metros[] |
OBJECT |
Contains information about a metro region that can be targeted by ads |
geoTargeting.metros[].countryCode |
STRING |
Country code of the country to which this metro region belongs |
geoTargeting.metros[].countryDartId |
INTEGER |
DART ID of the country to which this metro region belongs |
geoTargeting.metros[].dartId |
INTEGER |
DART ID of this metro region |
geoTargeting.metros[].dmaId |
INTEGER |
DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code |
geoTargeting.metros[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro" |
geoTargeting.metros[].metroCode |
STRING |
Metro code of this metro region. This is equivalent to dma_id |
geoTargeting.metros[].name |
STRING |
Name of this metro region |
geoTargeting.postalCodes[] |
OBJECT |
Contains information about a postal code that can be targeted by ads |
geoTargeting.postalCodes[].code |
STRING |
Postal code. This is equivalent to the id field |
geoTargeting.postalCodes[].countryCode |
STRING |
Country code of the country to which this postal code belongs |
geoTargeting.postalCodes[].countryDartId |
INTEGER |
DART ID of the country to which this postal code belongs |
geoTargeting.postalCodes[].id |
STRING |
ID of this postal code |
geoTargeting.postalCodes[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode" |
geoTargeting.regions[] |
OBJECT |
Contains information about a region that can be targeted by ads |
geoTargeting.regions[].countryCode |
STRING |
Country code of the country to which this region belongs |
geoTargeting.regions[].countryDartId |
INTEGER |
DART ID of the country to which this region belongs |
geoTargeting.regions[].dartId |
INTEGER |
DART ID of this region |
geoTargeting.regions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#region" |
geoTargeting.regions[].name |
STRING |
Name of this region |
geoTargeting.regions[].regionCode |
STRING |
Region code |
id |
INTEGER |
ID of this targeting template. This is a read-only, auto-generated field |
keyValueTargetingExpression |
OBJECT |
Key Value Targeting Expression |
keyValueTargetingExpression.expression |
STRING |
Keyword expression being targeted by the ad |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate" |
languageTargeting |
OBJECT |
Language Targeting |
languageTargeting.languages[] |
OBJECT |
Contains information about a language that can be targeted by ads |
languageTargeting.languages[].id |
INTEGER |
Language ID of this language. This is the ID used for targeting and generating reports |
languageTargeting.languages[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#language" |
languageTargeting.languages[].languageCode |
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 |
languageTargeting.languages[].name |
STRING |
Name of this language |
listTargetingExpression |
OBJECT |
Remarketing List Targeting Expression |
listTargetingExpression.expression |
STRING |
Expression describing which lists are being targeted by the ad |
name |
STRING |
Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser |
subaccountId |
INTEGER |
Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
technologyTargeting |
OBJECT |
Technology Targeting |
technologyTargeting.browsers[] |
OBJECT |
Contains information about a browser that can be targeted by ads |
technologyTargeting.browsers[].browserVersionId |
INTEGER |
ID referring to this grouping of browser and version numbers. This is the ID used for targeting |
technologyTargeting.browsers[].dartId |
INTEGER |
DART ID of this browser. This is the ID used when generating reports |
technologyTargeting.browsers[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser" |
technologyTargeting.browsers[].majorVersion |
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 |
technologyTargeting.browsers[].minorVersion |
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 |
technologyTargeting.browsers[].name |
STRING |
Name of this browser |
technologyTargeting.connectionTypes[] |
OBJECT |
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 |
technologyTargeting.connectionTypes[].id |
INTEGER |
ID of this connection type |
technologyTargeting.connectionTypes[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType" |
technologyTargeting.connectionTypes[].name |
STRING |
Name of this connection type |
technologyTargeting.mobileCarriers[] |
OBJECT |
Contains information about a mobile carrier that can be targeted by ads |
technologyTargeting.mobileCarriers[].countryCode |
STRING |
Country code of the country to which this mobile carrier belongs |
technologyTargeting.mobileCarriers[].countryDartId |
INTEGER |
DART ID of the country to which this mobile carrier belongs |
technologyTargeting.mobileCarriers[].id |
INTEGER |
ID of this mobile carrier |
technologyTargeting.mobileCarriers[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier" |
technologyTargeting.mobileCarriers[].name |
STRING |
Name of this mobile carrier |
technologyTargeting.operatingSystemVersions[] |
OBJECT |
Contains information about a particular version of an operating system that can be targeted by ads |
technologyTargeting.operatingSystemVersions[].id |
INTEGER |
ID of this operating system version |
technologyTargeting.operatingSystemVersions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion" |
technologyTargeting.operatingSystemVersions[].majorVersion |
STRING |
Major version (leftmost number) of this operating system version |
technologyTargeting.operatingSystemVersions[].minorVersion |
STRING |
Minor version (number after the first dot) of this operating system version |
technologyTargeting.operatingSystemVersions[].name |
STRING |
Name of this operating system version |
technologyTargeting.operatingSystemVersions[].operatingSystem |
OBJECT |
Contains information about an operating system that can be targeted by ads |
technologyTargeting.operatingSystemVersions[].operatingSystem.dartId |
INTEGER |
DART ID of this operating system. This is the ID used for targeting |
technologyTargeting.operatingSystemVersions[].operatingSystem.desktop |
BOOLEAN |
Whether this operating system is for desktop |
technologyTargeting.operatingSystemVersions[].operatingSystem.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
technologyTargeting.operatingSystemVersions[].operatingSystem.mobile |
BOOLEAN |
Whether this operating system is for mobile |
technologyTargeting.operatingSystemVersions[].operatingSystem.name |
STRING |
Name of this operating system |
technologyTargeting.operatingSystems[] |
OBJECT |
Contains information about an operating system that can be targeted by ads |
technologyTargeting.operatingSystems[].dartId |
INTEGER |
DART ID of this operating system. This is the ID used for targeting |
technologyTargeting.operatingSystems[].desktop |
BOOLEAN |
Whether this operating system is for desktop |
technologyTargeting.operatingSystems[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
technologyTargeting.operatingSystems[].mobile |
BOOLEAN |
Whether this operating system is for mobile |
technologyTargeting.operatingSystems[].name |
STRING |
Name of this operating system |
technologyTargeting.platformTypes[] |
OBJECT |
Contains information about a platform type that can be targeted by ads |
technologyTargeting.platformTypes[].id |
INTEGER |
ID of this platform type |
technologyTargeting.platformTypes[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType" |
technologyTargeting.platformTypes[].name |
STRING |
Name of this platform type |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Targeting template ID |
|
accountId INTEGER Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
|
advertiserId INTEGER Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION 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 |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
dayPartTargeting OBJECT Day Part Targeting |
|
dayPartTargeting.daysOfWeek[] ENUMERATION |
|
dayPartTargeting.hoursOfDay[] INTEGER |
|
dayPartTargeting.userLocalTime BOOLEAN Whether or not to use the user's local time. If false, the America/New York time zone applies |
|
geoTargeting OBJECT Geographical Targeting |
|
geoTargeting.cities[] OBJECT Contains information about a city that can be targeted by ads |
|
geoTargeting.cities[].countryCode STRING Country code of the country to which this city belongs |
|
geoTargeting.cities[].countryDartId INTEGER DART ID of the country to which this city belongs |
|
geoTargeting.cities[].dartId INTEGER DART ID of this city. This is the ID used for targeting and generating reports |
|
geoTargeting.cities[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#city" |
|
geoTargeting.cities[].metroCode STRING Metro region code of the metro region (DMA) to which this city belongs |
|
geoTargeting.cities[].metroDmaId INTEGER ID of the metro region (DMA) to which this city belongs |
|
geoTargeting.cities[].name STRING Name of this city |
|
geoTargeting.cities[].regionCode STRING Region code of the region to which this city belongs |
|
geoTargeting.cities[].regionDartId INTEGER DART ID of the region to which this city belongs |
|
geoTargeting.countries[] OBJECT Contains information about a country that can be targeted by ads |
|
geoTargeting.countries[].countryCode STRING Country code |
|
geoTargeting.countries[].dartId INTEGER DART ID of this country. This is the ID used for targeting and generating reports |
|
geoTargeting.countries[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#country" |
|
geoTargeting.countries[].name STRING Name of this country |
|
geoTargeting.countries[].sslEnabled BOOLEAN Whether ad serving supports secure servers in this country |
|
geoTargeting.excludeCountries BOOLEAN 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 |
|
geoTargeting.metros[] OBJECT Contains information about a metro region that can be targeted by ads |
|
geoTargeting.metros[].countryCode STRING Country code of the country to which this metro region belongs |
|
geoTargeting.metros[].countryDartId INTEGER DART ID of the country to which this metro region belongs |
|
geoTargeting.metros[].dartId INTEGER DART ID of this metro region |
|
geoTargeting.metros[].dmaId INTEGER DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code |
|
geoTargeting.metros[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro" |
|
geoTargeting.metros[].metroCode STRING Metro code of this metro region. This is equivalent to dma_id |
|
geoTargeting.metros[].name STRING Name of this metro region |
|
geoTargeting.postalCodes[] OBJECT Contains information about a postal code that can be targeted by ads |
|
geoTargeting.postalCodes[].code STRING Postal code. This is equivalent to the id field |
|
geoTargeting.postalCodes[].countryCode STRING Country code of the country to which this postal code belongs |
|
geoTargeting.postalCodes[].countryDartId INTEGER DART ID of the country to which this postal code belongs |
|
geoTargeting.postalCodes[].id STRING ID of this postal code |
|
geoTargeting.postalCodes[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode" |
|
geoTargeting.regions[] OBJECT Contains information about a region that can be targeted by ads |
|
geoTargeting.regions[].countryCode STRING Country code of the country to which this region belongs |
|
geoTargeting.regions[].countryDartId INTEGER DART ID of the country to which this region belongs |
|
geoTargeting.regions[].dartId INTEGER DART ID of this region |
|
geoTargeting.regions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#region" |
|
geoTargeting.regions[].name STRING Name of this region |
|
geoTargeting.regions[].regionCode STRING Region code |
|
id INTEGER ID of this targeting template. This is a read-only, auto-generated field |
|
keyValueTargetingExpression OBJECT Key Value Targeting Expression |
|
keyValueTargetingExpression.expression STRING Keyword expression being targeted by the ad |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate" |
|
languageTargeting OBJECT Language Targeting |
|
languageTargeting.languages[] OBJECT Contains information about a language that can be targeted by ads |
|
languageTargeting.languages[].id INTEGER Language ID of this language. This is the ID used for targeting and generating reports |
|
languageTargeting.languages[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#language" |
|
languageTargeting.languages[].languageCode 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 |
|
languageTargeting.languages[].name STRING Name of this language |
|
listTargetingExpression OBJECT Remarketing List Targeting Expression |
|
listTargetingExpression.expression STRING Expression describing which lists are being targeted by the ad |
|
name STRING Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser |
|
subaccountId INTEGER Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
|
technologyTargeting OBJECT Technology Targeting |
|
technologyTargeting.browsers[] OBJECT Contains information about a browser that can be targeted by ads |
|
technologyTargeting.browsers[].browserVersionId INTEGER ID referring to this grouping of browser and version numbers. This is the ID used for targeting |
|
technologyTargeting.browsers[].dartId INTEGER DART ID of this browser. This is the ID used when generating reports |
|
technologyTargeting.browsers[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser" |
|
technologyTargeting.browsers[].majorVersion 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 |
|
technologyTargeting.browsers[].minorVersion 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 |
|
technologyTargeting.browsers[].name STRING Name of this browser |
|
technologyTargeting.connectionTypes[] OBJECT 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 |
|
technologyTargeting.connectionTypes[].id INTEGER ID of this connection type |
|
technologyTargeting.connectionTypes[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType" |
|
technologyTargeting.connectionTypes[].name STRING Name of this connection type |
|
technologyTargeting.mobileCarriers[] OBJECT Contains information about a mobile carrier that can be targeted by ads |
|
technologyTargeting.mobileCarriers[].countryCode STRING Country code of the country to which this mobile carrier belongs |
|
technologyTargeting.mobileCarriers[].countryDartId INTEGER DART ID of the country to which this mobile carrier belongs |
|
technologyTargeting.mobileCarriers[].id INTEGER ID of this mobile carrier |
|
technologyTargeting.mobileCarriers[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier" |
|
technologyTargeting.mobileCarriers[].name STRING Name of this mobile carrier |
|
technologyTargeting.operatingSystemVersions[] OBJECT Contains information about a particular version of an operating system that can be targeted by ads |
|
technologyTargeting.operatingSystemVersions[].id INTEGER ID of this operating system version |
|
technologyTargeting.operatingSystemVersions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion" |
|
technologyTargeting.operatingSystemVersions[].majorVersion STRING Major version (leftmost number) of this operating system version |
|
technologyTargeting.operatingSystemVersions[].minorVersion STRING Minor version (number after the first dot) of this operating system version |
|
technologyTargeting.operatingSystemVersions[].name STRING Name of this operating system version |
|
technologyTargeting.operatingSystemVersions[].operatingSystem OBJECT Contains information about an operating system that can be targeted by ads |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.dartId INTEGER DART ID of this operating system. This is the ID used for targeting |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.desktop BOOLEAN Whether this operating system is for desktop |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.mobile BOOLEAN Whether this operating system is for mobile |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.name STRING Name of this operating system |
|
technologyTargeting.operatingSystems[] OBJECT Contains information about an operating system that can be targeted by ads |
|
technologyTargeting.operatingSystems[].dartId INTEGER DART ID of this operating system. This is the ID used for targeting |
|
technologyTargeting.operatingSystems[].desktop BOOLEAN Whether this operating system is for desktop |
|
technologyTargeting.operatingSystems[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
|
technologyTargeting.operatingSystems[].mobile BOOLEAN Whether this operating system is for mobile |
|
technologyTargeting.operatingSystems[].name STRING Name of this operating system |
|
technologyTargeting.platformTypes[] OBJECT Contains information about a platform type that can be targeted by ads |
|
technologyTargeting.platformTypes[].id INTEGER ID of this platform type |
|
technologyTargeting.platformTypes[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType" |
|
technologyTargeting.platformTypes[].name STRING Name of this platform type |
Output
This building block provides 106 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
advertiserId |
INTEGER |
Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
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 |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
dayPartTargeting |
OBJECT |
Day Part Targeting |
dayPartTargeting.daysOfWeek[] |
ENUMERATION |
|
dayPartTargeting.hoursOfDay[] |
INTEGER |
|
dayPartTargeting.userLocalTime |
BOOLEAN |
Whether or not to use the user's local time. If false, the America/New York time zone applies |
geoTargeting |
OBJECT |
Geographical Targeting |
geoTargeting.cities[] |
OBJECT |
Contains information about a city that can be targeted by ads |
geoTargeting.cities[].countryCode |
STRING |
Country code of the country to which this city belongs |
geoTargeting.cities[].countryDartId |
INTEGER |
DART ID of the country to which this city belongs |
geoTargeting.cities[].dartId |
INTEGER |
DART ID of this city. This is the ID used for targeting and generating reports |
geoTargeting.cities[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#city" |
geoTargeting.cities[].metroCode |
STRING |
Metro region code of the metro region (DMA) to which this city belongs |
geoTargeting.cities[].metroDmaId |
INTEGER |
ID of the metro region (DMA) to which this city belongs |
geoTargeting.cities[].name |
STRING |
Name of this city |
geoTargeting.cities[].regionCode |
STRING |
Region code of the region to which this city belongs |
geoTargeting.cities[].regionDartId |
INTEGER |
DART ID of the region to which this city belongs |
geoTargeting.countries[] |
OBJECT |
Contains information about a country that can be targeted by ads |
geoTargeting.countries[].countryCode |
STRING |
Country code |
geoTargeting.countries[].dartId |
INTEGER |
DART ID of this country. This is the ID used for targeting and generating reports |
geoTargeting.countries[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#country" |
geoTargeting.countries[].name |
STRING |
Name of this country |
geoTargeting.countries[].sslEnabled |
BOOLEAN |
Whether ad serving supports secure servers in this country |
geoTargeting.excludeCountries |
BOOLEAN |
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 |
geoTargeting.metros[] |
OBJECT |
Contains information about a metro region that can be targeted by ads |
geoTargeting.metros[].countryCode |
STRING |
Country code of the country to which this metro region belongs |
geoTargeting.metros[].countryDartId |
INTEGER |
DART ID of the country to which this metro region belongs |
geoTargeting.metros[].dartId |
INTEGER |
DART ID of this metro region |
geoTargeting.metros[].dmaId |
INTEGER |
DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code |
geoTargeting.metros[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro" |
geoTargeting.metros[].metroCode |
STRING |
Metro code of this metro region. This is equivalent to dma_id |
geoTargeting.metros[].name |
STRING |
Name of this metro region |
geoTargeting.postalCodes[] |
OBJECT |
Contains information about a postal code that can be targeted by ads |
geoTargeting.postalCodes[].code |
STRING |
Postal code. This is equivalent to the id field |
geoTargeting.postalCodes[].countryCode |
STRING |
Country code of the country to which this postal code belongs |
geoTargeting.postalCodes[].countryDartId |
INTEGER |
DART ID of the country to which this postal code belongs |
geoTargeting.postalCodes[].id |
STRING |
ID of this postal code |
geoTargeting.postalCodes[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode" |
geoTargeting.regions[] |
OBJECT |
Contains information about a region that can be targeted by ads |
geoTargeting.regions[].countryCode |
STRING |
Country code of the country to which this region belongs |
geoTargeting.regions[].countryDartId |
INTEGER |
DART ID of the country to which this region belongs |
geoTargeting.regions[].dartId |
INTEGER |
DART ID of this region |
geoTargeting.regions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#region" |
geoTargeting.regions[].name |
STRING |
Name of this region |
geoTargeting.regions[].regionCode |
STRING |
Region code |
id |
INTEGER |
ID of this targeting template. This is a read-only, auto-generated field |
keyValueTargetingExpression |
OBJECT |
Key Value Targeting Expression |
keyValueTargetingExpression.expression |
STRING |
Keyword expression being targeted by the ad |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate" |
languageTargeting |
OBJECT |
Language Targeting |
languageTargeting.languages[] |
OBJECT |
Contains information about a language that can be targeted by ads |
languageTargeting.languages[].id |
INTEGER |
Language ID of this language. This is the ID used for targeting and generating reports |
languageTargeting.languages[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#language" |
languageTargeting.languages[].languageCode |
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 |
languageTargeting.languages[].name |
STRING |
Name of this language |
listTargetingExpression |
OBJECT |
Remarketing List Targeting Expression |
listTargetingExpression.expression |
STRING |
Expression describing which lists are being targeted by the ad |
name |
STRING |
Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser |
subaccountId |
INTEGER |
Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
technologyTargeting |
OBJECT |
Technology Targeting |
technologyTargeting.browsers[] |
OBJECT |
Contains information about a browser that can be targeted by ads |
technologyTargeting.browsers[].browserVersionId |
INTEGER |
ID referring to this grouping of browser and version numbers. This is the ID used for targeting |
technologyTargeting.browsers[].dartId |
INTEGER |
DART ID of this browser. This is the ID used when generating reports |
technologyTargeting.browsers[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser" |
technologyTargeting.browsers[].majorVersion |
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 |
technologyTargeting.browsers[].minorVersion |
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 |
technologyTargeting.browsers[].name |
STRING |
Name of this browser |
technologyTargeting.connectionTypes[] |
OBJECT |
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 |
technologyTargeting.connectionTypes[].id |
INTEGER |
ID of this connection type |
technologyTargeting.connectionTypes[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType" |
technologyTargeting.connectionTypes[].name |
STRING |
Name of this connection type |
technologyTargeting.mobileCarriers[] |
OBJECT |
Contains information about a mobile carrier that can be targeted by ads |
technologyTargeting.mobileCarriers[].countryCode |
STRING |
Country code of the country to which this mobile carrier belongs |
technologyTargeting.mobileCarriers[].countryDartId |
INTEGER |
DART ID of the country to which this mobile carrier belongs |
technologyTargeting.mobileCarriers[].id |
INTEGER |
ID of this mobile carrier |
technologyTargeting.mobileCarriers[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier" |
technologyTargeting.mobileCarriers[].name |
STRING |
Name of this mobile carrier |
technologyTargeting.operatingSystemVersions[] |
OBJECT |
Contains information about a particular version of an operating system that can be targeted by ads |
technologyTargeting.operatingSystemVersions[].id |
INTEGER |
ID of this operating system version |
technologyTargeting.operatingSystemVersions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion" |
technologyTargeting.operatingSystemVersions[].majorVersion |
STRING |
Major version (leftmost number) of this operating system version |
technologyTargeting.operatingSystemVersions[].minorVersion |
STRING |
Minor version (number after the first dot) of this operating system version |
technologyTargeting.operatingSystemVersions[].name |
STRING |
Name of this operating system version |
technologyTargeting.operatingSystemVersions[].operatingSystem |
OBJECT |
Contains information about an operating system that can be targeted by ads |
technologyTargeting.operatingSystemVersions[].operatingSystem.dartId |
INTEGER |
DART ID of this operating system. This is the ID used for targeting |
technologyTargeting.operatingSystemVersions[].operatingSystem.desktop |
BOOLEAN |
Whether this operating system is for desktop |
technologyTargeting.operatingSystemVersions[].operatingSystem.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
technologyTargeting.operatingSystemVersions[].operatingSystem.mobile |
BOOLEAN |
Whether this operating system is for mobile |
technologyTargeting.operatingSystemVersions[].operatingSystem.name |
STRING |
Name of this operating system |
technologyTargeting.operatingSystems[] |
OBJECT |
Contains information about an operating system that can be targeted by ads |
technologyTargeting.operatingSystems[].dartId |
INTEGER |
DART ID of this operating system. This is the ID used for targeting |
technologyTargeting.operatingSystems[].desktop |
BOOLEAN |
Whether this operating system is for desktop |
technologyTargeting.operatingSystems[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
technologyTargeting.operatingSystems[].mobile |
BOOLEAN |
Whether this operating system is for mobile |
technologyTargeting.operatingSystems[].name |
STRING |
Name of this operating system |
technologyTargeting.platformTypes[] |
OBJECT |
Contains information about a platform type that can be targeted by ads |
technologyTargeting.platformTypes[].id |
INTEGER |
ID of this platform type |
technologyTargeting.platformTypes[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType" |
technologyTargeting.platformTypes[].name |
STRING |
Name of this platform type |
= Parameter name
= Format
|
accountId INTEGER Account ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
|
advertiserId INTEGER Advertiser ID of this targeting template. This is a required field on insert and is read-only after insert |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION 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 |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
dayPartTargeting OBJECT Day Part Targeting |
|
dayPartTargeting.daysOfWeek[] ENUMERATION |
|
dayPartTargeting.hoursOfDay[] INTEGER |
|
dayPartTargeting.userLocalTime BOOLEAN Whether or not to use the user's local time. If false, the America/New York time zone applies |
|
geoTargeting OBJECT Geographical Targeting |
|
geoTargeting.cities[] OBJECT Contains information about a city that can be targeted by ads |
|
geoTargeting.cities[].countryCode STRING Country code of the country to which this city belongs |
|
geoTargeting.cities[].countryDartId INTEGER DART ID of the country to which this city belongs |
|
geoTargeting.cities[].dartId INTEGER DART ID of this city. This is the ID used for targeting and generating reports |
|
geoTargeting.cities[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#city" |
|
geoTargeting.cities[].metroCode STRING Metro region code of the metro region (DMA) to which this city belongs |
|
geoTargeting.cities[].metroDmaId INTEGER ID of the metro region (DMA) to which this city belongs |
|
geoTargeting.cities[].name STRING Name of this city |
|
geoTargeting.cities[].regionCode STRING Region code of the region to which this city belongs |
|
geoTargeting.cities[].regionDartId INTEGER DART ID of the region to which this city belongs |
|
geoTargeting.countries[] OBJECT Contains information about a country that can be targeted by ads |
|
geoTargeting.countries[].countryCode STRING Country code |
|
geoTargeting.countries[].dartId INTEGER DART ID of this country. This is the ID used for targeting and generating reports |
|
geoTargeting.countries[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#country" |
|
geoTargeting.countries[].name STRING Name of this country |
|
geoTargeting.countries[].sslEnabled BOOLEAN Whether ad serving supports secure servers in this country |
|
geoTargeting.excludeCountries BOOLEAN 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 |
|
geoTargeting.metros[] OBJECT Contains information about a metro region that can be targeted by ads |
|
geoTargeting.metros[].countryCode STRING Country code of the country to which this metro region belongs |
|
geoTargeting.metros[].countryDartId INTEGER DART ID of the country to which this metro region belongs |
|
geoTargeting.metros[].dartId INTEGER DART ID of this metro region |
|
geoTargeting.metros[].dmaId INTEGER DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code |
|
geoTargeting.metros[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro" |
|
geoTargeting.metros[].metroCode STRING Metro code of this metro region. This is equivalent to dma_id |
|
geoTargeting.metros[].name STRING Name of this metro region |
|
geoTargeting.postalCodes[] OBJECT Contains information about a postal code that can be targeted by ads |
|
geoTargeting.postalCodes[].code STRING Postal code. This is equivalent to the id field |
|
geoTargeting.postalCodes[].countryCode STRING Country code of the country to which this postal code belongs |
|
geoTargeting.postalCodes[].countryDartId INTEGER DART ID of the country to which this postal code belongs |
|
geoTargeting.postalCodes[].id STRING ID of this postal code |
|
geoTargeting.postalCodes[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode" |
|
geoTargeting.regions[] OBJECT Contains information about a region that can be targeted by ads |
|
geoTargeting.regions[].countryCode STRING Country code of the country to which this region belongs |
|
geoTargeting.regions[].countryDartId INTEGER DART ID of the country to which this region belongs |
|
geoTargeting.regions[].dartId INTEGER DART ID of this region |
|
geoTargeting.regions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#region" |
|
geoTargeting.regions[].name STRING Name of this region |
|
geoTargeting.regions[].regionCode STRING Region code |
|
id INTEGER ID of this targeting template. This is a read-only, auto-generated field |
|
keyValueTargetingExpression OBJECT Key Value Targeting Expression |
|
keyValueTargetingExpression.expression STRING Keyword expression being targeted by the ad |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetingTemplate" |
|
languageTargeting OBJECT Language Targeting |
|
languageTargeting.languages[] OBJECT Contains information about a language that can be targeted by ads |
|
languageTargeting.languages[].id INTEGER Language ID of this language. This is the ID used for targeting and generating reports |
|
languageTargeting.languages[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#language" |
|
languageTargeting.languages[].languageCode 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 |
|
languageTargeting.languages[].name STRING Name of this language |
|
listTargetingExpression OBJECT Remarketing List Targeting Expression |
|
listTargetingExpression.expression STRING Expression describing which lists are being targeted by the ad |
|
name STRING Name of this targeting template. This field is required. It must be less than 256 characters long and unique within an advertiser |
|
subaccountId INTEGER Subaccount ID of this targeting template. This field, if left unset, will be auto-generated on insert and is read-only after insert |
|
technologyTargeting OBJECT Technology Targeting |
|
technologyTargeting.browsers[] OBJECT Contains information about a browser that can be targeted by ads |
|
technologyTargeting.browsers[].browserVersionId INTEGER ID referring to this grouping of browser and version numbers. This is the ID used for targeting |
|
technologyTargeting.browsers[].dartId INTEGER DART ID of this browser. This is the ID used when generating reports |
|
technologyTargeting.browsers[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser" |
|
technologyTargeting.browsers[].majorVersion 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 |
|
technologyTargeting.browsers[].minorVersion 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 |
|
technologyTargeting.browsers[].name STRING Name of this browser |
|
technologyTargeting.connectionTypes[] OBJECT 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 |
|
technologyTargeting.connectionTypes[].id INTEGER ID of this connection type |
|
technologyTargeting.connectionTypes[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType" |
|
technologyTargeting.connectionTypes[].name STRING Name of this connection type |
|
technologyTargeting.mobileCarriers[] OBJECT Contains information about a mobile carrier that can be targeted by ads |
|
technologyTargeting.mobileCarriers[].countryCode STRING Country code of the country to which this mobile carrier belongs |
|
technologyTargeting.mobileCarriers[].countryDartId INTEGER DART ID of the country to which this mobile carrier belongs |
|
technologyTargeting.mobileCarriers[].id INTEGER ID of this mobile carrier |
|
technologyTargeting.mobileCarriers[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier" |
|
technologyTargeting.mobileCarriers[].name STRING Name of this mobile carrier |
|
technologyTargeting.operatingSystemVersions[] OBJECT Contains information about a particular version of an operating system that can be targeted by ads |
|
technologyTargeting.operatingSystemVersions[].id INTEGER ID of this operating system version |
|
technologyTargeting.operatingSystemVersions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion" |
|
technologyTargeting.operatingSystemVersions[].majorVersion STRING Major version (leftmost number) of this operating system version |
|
technologyTargeting.operatingSystemVersions[].minorVersion STRING Minor version (number after the first dot) of this operating system version |
|
technologyTargeting.operatingSystemVersions[].name STRING Name of this operating system version |
|
technologyTargeting.operatingSystemVersions[].operatingSystem OBJECT Contains information about an operating system that can be targeted by ads |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.dartId INTEGER DART ID of this operating system. This is the ID used for targeting |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.desktop BOOLEAN Whether this operating system is for desktop |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.mobile BOOLEAN Whether this operating system is for mobile |
|
technologyTargeting.operatingSystemVersions[].operatingSystem.name STRING Name of this operating system |
|
technologyTargeting.operatingSystems[] OBJECT Contains information about an operating system that can be targeted by ads |
|
technologyTargeting.operatingSystems[].dartId INTEGER DART ID of this operating system. This is the ID used for targeting |
|
technologyTargeting.operatingSystems[].desktop BOOLEAN Whether this operating system is for desktop |
|
technologyTargeting.operatingSystems[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem" |
|
technologyTargeting.operatingSystems[].mobile BOOLEAN Whether this operating system is for mobile |
|
technologyTargeting.operatingSystems[].name STRING Name of this operating system |
|
technologyTargeting.platformTypes[] OBJECT Contains information about a platform type that can be targeted by ads |
|
technologyTargeting.platformTypes[].id INTEGER ID of this platform type |
|
technologyTargeting.platformTypes[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType" |
|
technologyTargeting.platformTypes[].name STRING Name of this platform type |